{\rtf1\ansi\ansicpg1252\cocoartf1038\cocoasubrtf250
{\fonttbl\f0\froman\fcharset0 Times-Roman;\f1\fmodern\fcharset0 Courier;}
{\colortbl;\red255\green255\blue255;\red0\green23\blue229;}
\margl1440\margr1440\vieww16040\viewh19300\viewkind0
\deftab720
\pard\pardeftab720\sa320\ql\qnatural

\f0\b\fs48 \cf0 Introduction\
\pard\pardeftab720\sa240\ql\qnatural

\b0\fs24 \cf0 There are two methods used to connect the xnatfs WebDAV server to an XNAT instance. The first is a {\field{\*\fldinst{HYPERLINK "http://code.google.com/p/xnatfs/wiki/UsageSummary#Standalone-Server"}}{\fldrslt \cf2 \ul \ulc2 standalone server}} bundled with Jetty into an executable jar file. The second is a {\field{\*\fldinst{HYPERLINK "http://code.google.com/p/xnatfs/wiki/UsageSummary#Servlet"}}{\fldrslt \cf2 \ul \ulc2 standard servlet}} bundled as a J2EE war file. Both methods allow connection to the WebDAV server in a similar manner.\
\pard\pardeftab720\sa280\ql\qnatural

\b\fs36 \cf0 Standalone Server\
\pard\pardeftab720\sa240\ql\qnatural

\b0\fs24 \cf0 xnatfsStandalone.jar implements a local WebDAV server for XNAT. The server requests authentication credentials that are passed onto the XNAT server.\
\pard\pardeftab720\sa280\ql\qnatural

\b\fs28 \cf0 Usage\
\pard\pardeftab720\ql\qnatural

\f1\b0\fs24 \cf0 java -jar xnatfsStandalone.jar --server central.xnat.org --scheme https --port 80 8081\
\pard\pardeftab720\sa240\ql\qnatural

\f0 \cf0 Arguments\
\pard\pardeftab720\ql\qnatural

\f1 \cf0 \'a0--server \'a0 -- XNAT instance to connect to\
\'a0--scheme \'a0 -- prefix on URL (http or https supported)\
\'a0--port \'a0 \'a0 -- port on the XNAT instance (80 is default)\
\'a0<port> \'a0 \'a0 -- Local port to run the WebDAV server (8080 is the default)\
\pard\pardeftab720\sa240\ql\qnatural

\f0 \cf0 On the Mac, you can connect through Finder->Go->Connect to Server... with a URL of {\field{\*\fldinst{HYPERLINK "http://127.0.0.1:8081/"}}{\fldrslt \cf2 \ul \ulc2 http://127.0.0.1:8081}}. Incidentally, you can use a web browser to do the same thing. Not sure what you need to do under Windows. From what I've read, WebDAV support is fairly broken under WinXP, and only slightly better using Vista. Haven't tried Win7 yet. Under Linux, the various file managers support WebDAV fairly well. In all cases, the server will prompt you for your username/password. Use your XNAT credentials, which will be forwarded on to the XNAT instance.\
At the moment, the local data is served using http, but we could implement https, I think. Though I haven't tried it, I think more than one user can connect at a time, all with different XNAT credentials.\
\pard\pardeftab720\sa280\ql\qnatural

\b\fs36 \cf0 Servlet\
\pard\pardeftab720\sa240\ql\qnatural

\b0\fs24 \cf0 A servlet implementing the WebDAV protocol is bundled into a standard war archive. This may be deployed on any Servlet engine. Place the xnatfs.war file in the webapp's directory of your favorite Servlet engine.\
\pard\pardeftab720\sa280\ql\qnatural

\b\fs28 \cf0 Deployment on XNAT instance\
\pard\pardeftab720\sa240\ql\qnatural

\b0\fs24 \cf0 If xnatfs is deployed on the same server as the XNAT instance, i.e. if the war file is placed in the same webapps directory as XNAT, no configuration is required. If custom configuration is required, see the next section.\
\pard\pardeftab720\sa280\ql\qnatural

\b\fs28 \cf0 Deployment on standalone Servlet engine\
\pard\pardeftab720\sa240\ql\qnatural

\b0\fs24 \cf0 The configuration options for the servlet version of xnatfs are similar to the standalone distribution. Configuration is through a simple properties file in the 
\f1 xnatfs/WEB-INF/XNATFS.properties
\f0 . Currently, the only recognized property is 
\f1 url
\f0 :\
\pard\pardeftab720\ql\qnatural

\f1 \cf0 url = http://central.xnat.org/REST\
\
\pard\pardeftab720\sa240\ql\qnatural

\f0 \cf0 For the curious, once the war file has been unpacked, the 
\f1 xnatfs/WEB-INF/web.xml
\f0  file has the following tags:\
\pard\pardeftab720\ql\qnatural

\f1 \cf0 \'a0 \'a0 \'a0 <servlet> \
\'a0 \'a0 \'a0 \'a0 <servlet-name>xnatfs</servlet-name>\
\'a0 \'a0 \'a0 \'a0 <!-- <servlet-class>org.xnat.xnatfs.webdav.xnatfsServlet</servlet-class> -->\
\'a0 \'a0 \'a0 \'a0 <servlet-class>com.bradmcevoy.http.MiltonServlet</servlet-class>\
\'a0 \'a0 \'a0 \'a0 <init-param>\
\'a0 \'a0 \'a0 \'a0 \'a0 \'a0 <param-name>resource.factory.class</param-name>\
\'a0 \'a0 \'a0 \'a0 \'a0 \'a0 <param-value>org.xnat.xnatfs.webdav.XNATFS</param-value>\
\'a0 \'a0 \'a0 \'a0 </init-param>\
\'a0 \'a0 \'a0 \'a0 <init-param>\
\'a0 \'a0 \'a0 \'a0 \'a0 <param-name>filter_0</param-name>\
\'a0 \'a0 \'a0 \'a0 \'a0 <param-value>org.xnat.xnatfs.filter.AuthenticationFilter</param-value>\
\'a0 \'a0 \'a0 \'a0 </init-param>\
\'a0 \'a0 \'a0 \'a0 <init-param>\
\'a0 \'a0 \'a0 \'a0 \'a0 <param-name>filter_1</param-name>\
\'a0 \'a0 \'a0 \'a0 \'a0 <param-value>org.xnat.xnatfs.filter.ChatterFilter</param-value>\
\'a0 \'a0 \'a0 \'a0 </init-param>\
\'a0 \'a0 \'a0 \'a0 <init-param>\
\'a0 \'a0 \'a0 \'a0 \'a0 \'a0 <param-name>not.found.url</param-name>\
\'a0 \'a0 \'a0 \'a0 \'a0 \'a0 <param-value>/404.jsp</param-value>\
\'a0 \'a0 \'a0 \'a0 </init-param>\
\'a0 \'a0 </servlet>\
\pard\pardeftab720\sa240\ql\qnatural

\f0\b \cf0 It is not advised to change any of the tags unless you know what you are doing.
\b0 \
The 
\f1 filter_0
\f0  and 
\f1 filter_1
\f0  parameters instruct the WebDAV code to create the filters. The 
\f1 AuthenticationFilter
\f0  ensures that the client is fully authenticated, before any resources are requested and the 
\f1 ChatterFilter
\f0  helps to cut down on unnecessary transmissions.\
\pard\pardeftab720\sa320\ql\qnatural

\b\fs48 \cf0 Connecting to xnatfs\
\pard\pardeftab720\sa240\ql\qnatural

\b0\fs24 \cf0 When connecting to xnatfs, you will be prompted for your username/password. Please use your XNAT credentials. NB: these will be transmitted to xnatfs more or less in plain text, and transmitted to XNAT in the same manner. This is the same behavior as if you were connecting directly to the XNAT instance. The https protocol (see the --scheme argument above) is the recommended connection scheme.\
\pard\pardeftab720\sa240\ql\qnatural

\b \cf0 NB:
\b0  If you are using the servlet version of xnatfs, the correct URL to connect to the WebDAV server is 
\f1 http://localhost:80/xnatfs
\f0 . The port depends on the servlet engine used to host the war, and the 
\f1 /xnatfs
\f0  can be modified in the web.xml file as above.\

\b Browser Instructions:
\b0 \
Simply point your browser to {\field{\*\fldinst{HYPERLINK "http://localhost:8081/"}}{\fldrslt \cf2 \ul \ulc2 http://localhost:8081}}. This interface, though not as fancy as the full WebDAV interface, will allow any files to be downloaded.\

\b Mac Instructions:
\b0 \
On the Mac, you can connect through Finder->Go->Connect to Server... with a URL of {\field{\*\fldinst{HYPERLINK "http://127.0.0.1:8081/"}}{\fldrslt \cf2 \ul \ulc2 http://127.0.0.1:8081}}. Incidentally, you can use a web browser to do the same thing.\

\b Windows Instructions:
\b0 \
Not sure what you need to do under Windows. From what I've read, WebDAV support is fairly broken under WinXP, and only slightly better using Vista. Haven't tried Win7 yet. Some help may be found here {\field{\*\fldinst{HYPERLINK "http://www.wikispaces.com/WebDAV+Windows+XP"}}{\fldrslt \cf2 \ul \ulc2 http://www.wikispaces.com/WebDAV+Windows+XP}} and {\field{\*\fldinst{HYPERLINK "http://www.powers1.net/techup/node/2"}}{\fldrslt \cf2 \ul \ulc2 http://www.powers1.net/techup/node/2}} using NetDrive{\field{\*\fldinst{HYPERLINK "http://code.google.com/p/xnatfs/w/edit/NetDrive"}}{\fldrslt \cf2 \ul \ulc2 ?}}.\

\b Linux/Unix Instructions:
\b0 \
Under Linux, the various file managers support WebDAV fairly well. In all cases, the server will prompt you for your username/password. Use your XNAT credentials, which will be forwarded on to the XNAT instance.\
\pard\pardeftab720\sa320\ql\qnatural

\b\fs48 \cf0 Known Issues\
\pard\pardeftab720\sa240\ql\qnatural

\b0\fs24 \cf0 On the Mac, if a file is opened or copied from an expanded folder in list view, xnatfs hangs for some unknown reason, and the file can not be copied due to insufficient privileges.\
At the moment, the local data is served using http, but we could implement https, I think. Though I haven't tried it, I think more than one user can connect at a time, all with different XNAT credentials.\
\pard\pardeftab720\sa320\ql\qnatural

\b\fs48 \cf0 Contact Information\
\pard\pardeftab720\sa240\ql\qnatural

\b0\fs24 \cf0 Please contact Daniel Blezek ({\field{\*\fldinst{HYPERLINK "mailto:daniel.blezek@gmail.com"}}{\fldrslt \cf2 \ul \ulc2 daniel.blezek@gmail.com}}) with any comments, bugs or suggestions.\
The project page for xnatfs is hosted by Google Code {\field{\*\fldinst{HYPERLINK "http://code.google.com/p/xnatfs/"}}{\fldrslt \cf2 \ul \ulc2 http://code.google.com/p/xnatfs/}}.\
}